Node / public / reticulum / files / docs / source / examples.rst

Displaying Raw • Download

Tb4b4b4.. Tff7b72_examples-main:

Tc9d1d9********

Tc9d1d9Examples

Tc9d1d9********

A number of examples are included in the source distribution of Reticulum.

You can use these examples to learn how to write your own programs.

Tb4b4b4.. Tff7b72_example-minimal:

Tc9d1d9Minimal

Tc9d1d9=======

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Minimal.py>`_.

The *Minimal* example demonstrates the bare-minimum setup required to connect to

a Reticulum network from your program. In about five lines of code, you will

have the Reticulum Network Stack initialised, and ready to pass traffic in your

program.

Tb4b4b4.. Tff7b72_example-announce:

Tc9d1d9Announce

Tc9d1d9========

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py>`_.

The *Announce* example builds upon the previous example by exploring how to

announce a destination on the network, and how to let your program receive

notifications about announces from relevant destinations.

Tb4b4b4.. Tff7b72_example-broadcast:

Tc9d1d9Broadcast

Tc9d1d9=========

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Broadcast.py>`_.

The *Broadcast* example explores how to transmit plaintext broadcast messages

over the network.

Tb4b4b4.. Tff7b72_example-echo:

Tc9d1d9Echo

Tc9d1d9====

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py>`_.

The *Echo* example demonstrates communication between two destinations using

the Packet interface.

Tb4b4b4.. Tff7b72_example-link:

Tc9d1d9Link

Tc9d1d9====

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py>`_.

The *Link* example explores establishing an encrypted link to a remote

destination, and passing traffic back and forth over the link.

Tb4b4b4.. Tff7b72_example-filetransfer:

Tc9d1d9Filetransfer

Tc9d1d9============

This example can be found at Ta5d6ff`<https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py>`_.

The *Filetransfer* example implements a basic file-server program that

allow clients to connect and download files. The program uses the Resource

interface to efficiently pass files of any size over a Reticulum Te6edf3:ref:Te6edf3`Link<api-link>`.